API

Procurement APIs

PUT procurement/returns/{supplierReturnId}/items/{itemId}

Stores information about supplier return order item.

HTTP method PUT
URI https://api.rambase.net/procurement/returns/{supplierReturnId}/items/{itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierReturnId} Supplier return identifier
Integer, minimum 100000
- URI parameter {itemId} Supplier return item identifier
Integer, minimum 1
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 3235, version 7

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<SupplierReturnItem
SupplierReturnItem

This field is optional.

>
2
     <SuppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

This field is optional.

>{String}</SuppliersReferenceNumber>
3
     <SuppliersProductName
SuppliersProductName

Suppliers internal name of the product. Retrieved from the product.

This field is optional.

>{String}</SuppliersProductName>
4
     <ProductStructureRevision
ProductStructureRevision

The revision of the product structure

This field is optional.

>{String}</ProductStructureRevision>
5
     <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

This field is optional.

>{String}</Note>
6
     <Quantity
Quantity

Quantity of the supplier return item

Minimum value: 0

This field is optional.

>{Decimal}</Quantity>
7
     <RequireSerialNumberBeforeShipping
RequireSerialNumberBeforeShipping

True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.

This field is optional.

>{Boolean}</RequireSerialNumberBeforeShipping>
8
     <Price
Price

This field is optional.

>
9
          <NetPrice
NetPrice

Final price per unit after deducting all discounts etc.

Minimum value: 0

This field is optional.

>{Decimal}</NetPrice>
10
     </Price>
11
     <Product
Product

This field is optional.

>
12
          <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
13
     </Product>
14
     <ManufacturersProduct
ManufacturersProduct

This field is optional.

>
15
          <ManufacturersProductId
ManufacturersProductId

Manufacturer product identifier

Minimum value: 100000

This field is optional.

>{Integer}</ManufacturersProductId>
16
     </ManufacturersProduct>
17
     <Accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

This field is optional.

>
18
          <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
19
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
20
          </VATCodeDefinition>
21
     </Accounting>
22
</SupplierReturnItem>
1
{
2
     "supplierReturnItem
SupplierReturnItem

This field is optional.

": {
3
          "suppliersReferenceNumber
SuppliersReferenceNumber

Suppliers/sellers item reference number. Typically to an external system.

This field is optional.

": "{String}",
4
          "suppliersProductName
SuppliersProductName

Suppliers internal name of the product. Retrieved from the product.

This field is optional.

": "{String}",
5
          "productStructureRevision
ProductStructureRevision

The revision of the product structure

This field is optional.

": "{String}",
6
          "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

This field is optional.

": "{String}",
7
          "quantity
Quantity

Quantity of the supplier return item

Minimum value: 0

This field is optional.

": "{Decimal}",
8
          "requireSerialNumberBeforeShipping
RequireSerialNumberBeforeShipping

True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.

This field is optional.

": "{Boolean}",
9
          "price
Price

This field is optional.

": {
10
               "netPrice
NetPrice

Final price per unit after deducting all discounts etc.

Minimum value: 0

This field is optional.

": "{Decimal}"
11
          },
12
          "product
Product

This field is optional.

": {
13
               "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
14
          },
15
          "manufacturersProduct
ManufacturersProduct

This field is optional.

": {
16
               "manufacturersProductId
ManufacturersProductId

Manufacturer product identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
17
          },
18
          "accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

This field is optional.

": {
19
               "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
20
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

": "{String}"
21
               }
22
          }
23
     }
24
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100601 HTTP 400 Missing required input parameters
Error 100209 HTTP 400 Illegal document Id {0}
Error 102746 HTTP 400 The parameter value can not be more than {0}
Error 102747 HTTP 400 Error in formula: {0}
Error 107762 HTTP 400 Only product structures can auto create work orders for sub production
Error 107763 HTTP 400 Only product structures can be set up for line production
Error 107764 HTTP 400 Only product structures can be externally manufactured
Error 101047 HTTP 400 The purchase quote item has too low available quantity
Error 101400 HTTP 400 Supplier credit claim has been created from shipping advice
Error 102483 HTTP 400 Finance project is required for general ledger account {0}
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
Error 101313 HTTP 400 Department number is not valid: {0}
Error 101320 HTTP 400 The project number is not valid: {0}
Error 101500 HTTP 400 Project {0} could not be used : Check project FromPeriod and ToPeriod.
Error 101501 HTTP 400 Asset is not allowed on general ledger account {0}
Error 101326 HTTP 400 The asset number is not valid : {0}
Error 102486 HTTP 400 Invalid value for dimension {0}